home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-07 / pe2ai.zip / PE2.DOC < prev    next >
Text File  |  1992-10-16  |  16KB  |  438 lines
  1.  AI-LANBIOS Low-Level Driver For XIRCOM Pocket Ethernet II Adapters (PE2.DOC)
  2.           -----------------------------------------------------
  3.                     (C) Copyright 1992 ARTISOFT, Inc.
  4.                            (Revised 10/15/92)
  5.  
  6. INTRODUCTION
  7. ============
  8.  
  9. The PE2AILAN.COM low-level AI-LANBIOS driver allows you to use your Xircom
  10. Pocket Ethernet II adapters in a LANtastic network.  The driver interfaces to
  11. the following hardware:
  12.  
  13.         PE2-10B2   Thin Ethernet adapter
  14.         PE2-10BT   Twisted Pair Ethernet adapter
  15.         PE2-10BX   Thick Ethernet adapter
  16.  
  17. In order for the Xircom adapter to operate with the LANtastic Network
  18. Operating System (NOS), you must first install the adapter as instructed
  19. in the Xircom User's Guide, then run the LANtastic INSTALL program. Choose 
  20. "Xircom PE10B2 Ethernet Adapter," copy PE2AILAN.COM from the Xircom diskette 
  21. to the \LANTASTI directory, then edit the STARTNET.BAT file as follows:
  22. replace the entire line containing PE.EXE and parameters with PE2AILAN.COM 
  23. followed by no parameters. When you reboot and run STARTNET, the supporting 
  24. software (PE2AILAN.COM and AILANBIO.EXE) will be loaded.  PE2AILAN.COM 
  25. communicates with the Xircom adapter, while AILANBIO.EXE provides high-level 
  26. communications across the local area network.  Because of this, you 
  27. cannot run any network software until after PE2AILAN.COM and AILANBIO.EXE
  28. have been loaded.  (Note: For additional information on running 
  29. AILANBIO.EXE, refer to AILANBIO.DOC on your LANtastic driver diskette.)
  30.  
  31. There are command line switches that you can use when you run PE2AILAN.COM and
  32. AILANBIO.EXE.  These switches allow you greater flexibility in using these
  33. programs.  For information on the AILANBIO.EXE command line options refer
  34. to AILANBIO.DOC on your LANtastic driver disk.  For information on PE2AILAN.COM
  35. command line switches, refer to "PE2AILAN.COM COMMAND LINE OPTIONS" in this
  36. file.
  37.  
  38.  
  39. RUNNING PE2AILAN.COM
  40. ====================
  41.  
  42. The syntax for running PE2AILAN.COM is
  43.  
  44.      PE2AILAN[switches . . . ] [ ; comment]
  45.  
  46. where "switches" denotes any optional command line switches.  If you are
  47. using more than one switch in a command line, use a space or a forward
  48. slash (/) to separate the arguments.  If a switch takes a value (such as
  49. when you designate the DOS multiplex number with the MPX= switch) the
  50. switch must be followed by an equal sign (=) or a colon (:).  All switch
  51. values are checked to make sure they are valid.  Illegal values produce
  52. error messages.
  53.  
  54. These are valid switch formats:
  55.  
  56.         SWITCH
  57.         /SWITCH
  58.         SWITCH:VALUE
  59.         /SWITCH=VALUE
  60.  
  61. You would use one of the first two formats for a switch that does not take
  62. a value.  For example:
  63.  
  64.         PE2AILAN/HELP
  65.  
  66. You would use the third or fourth formats for a switch that takes a value.
  67. Such as:
  68.  
  69.         PE2AILAN/MPX=D7
  70.  
  71.  
  72. PE2AILAN.COM COMMAND LINE OPTIONS
  73. =================================
  74.  
  75. The valid PE2AILAN.COM switches appear below.  The letters "ddd"  denote that
  76. you must provide a decimal number.  The letters "hh" denote a required
  77. hexadecimal value.  Values enclosed in brackets "[]" indicate default
  78. values if the switch is omitted.  Values after the brackets denote the
  79. valid range of variables for the switch.
  80.  
  81. ----------
  82.     @switch-file  
  83.  
  84. This option specifies that further switches are to be taken from an
  85. switch file.  Any switches after the @switch-file name will be used,
  86. and the switch settings take precedence over any settings in the switch
  87. file.  You may invoke switch files from within switch files as often as
  88. you wish.  The file should contain valid switches and may contain comment
  89. characters (;) at the beginning of each line or after switches.
  90.  
  91. For example,
  92.  
  93.      PE2AILAN @setup
  94.  
  95. The file SETUP contains
  96.  
  97.      ; PE2AILAN.COM AI-LANBIOS driver setup file
  98.      ;
  99.      MPX=D7            ; Use Multiplex number D7
  100.      IRQ=5             ; Use interrupt request 5
  101.      VERBOSE           ; Display verbose information
  102.  
  103. ----------
  104.      HELP or ?    
  105.  
  106. This switch instructs PE2AILAN.COM to display information about the valid
  107. command line switches, but does not install the PE2AILAN.COM driver.  For
  108. example,
  109.  
  110.      PE2AILAN/help
  111.      PE2AILAN ?
  112.  
  113. See the messages section for a detailed description of the HELP display
  114. output.
  115.  
  116. ----------
  117.      IRQ=d [7] 5 or 7
  118.  
  119. This switch specifies the interrupt request (IRQ) level for the card.  If
  120. you have more than one adapter installed, each should have its own unique
  121. IRQ.
  122.  
  123. ----------
  124.      LPT=d [1] Range 1 to 3
  125.  
  126. This switch allows you to specify the parallel port where the Pocket
  127. Ethernet Adapter II is installed.  You will need to use this switch if you've
  128. installed the adapter on LPT2 or LPT3.
  129.  
  130. ----------
  131.      MPX=hh [C7] Range C0-FF
  132.  
  133. This switch specifies the DOS multiplex (MPX) number to use for
  134. communication with AILANBIO.EXE.  You will need to change this value only
  135. if the default MPX number is in use by another application or NETBIOS.
  136. Multiplex numbers 00 through BF are reserved for DOS use; therefore, you
  137. must use a multiplex number between C0 and FF.
  138.  
  139. ----------
  140.      NON
  141.  
  142. This switch forces the driver to run in non-bidirectional mode on the 
  143. parallel port. The Xircom driver is designed to automatically select
  144. bidirectional or non-bidirectional parallel port mode according to what
  145. the hardware supports. Use this switch to override a bidirectional setting
  146. and force the computer into non-bidirectional mode.
  147.  
  148. ----------
  149.      PACKET_SIZE=dddd [1500] Range 574-1500
  150.  
  151. This switch specifies the maximum size of transmitted IEEE 802.3 packets.
  152. You may need to change this value when using certain bridges that do not
  153. support the full 1500-byte packet size.  Even when you reduce the packet
  154. size, the low-level driver can still receive larger packets.
  155.  
  156. ----------
  157.     REMOVE
  158.  
  159. This switch removes PE2AILAN.COM from memory.  You must remove TSR programs in
  160. the opposite order they were loaded.  For example, if you loaded PE2AILAN.COM
  161. and then AILANBIO, you must remove AILANBIO before PE2AILAN.COM.  In addition, if
  162. you have more than one invocation of PE2AILAN.COM and AILANBIO you must use the
  163. MPX= switch on the command line to specify which copy of PE2AILAN.COM but not
  164. (AILANBIO) that you want to unload.  For example, if you load two copies
  165. of PE2AILAN.COM and AILANBIO:
  166.  
  167. PE2AILAN.COM/MPX=C7
  168. AILANBIO/ADAPTER=0/MPX=C7
  169. PE2AILAN.COM/MPX=D7
  170. AILANBIO/ADAPTER=1/MPX=D7
  171.  
  172. To unload these copies of PE2AILAN.COM and AILANBIO:
  173.  
  174. AILANBIO/REMOVE
  175. PE2AILAN.COM/MPX=D7/REMOVE
  176. AILANBIO/REMOVE
  177. PE2AILAN.COM/MPX=C7/REMOVE
  178.  
  179. The REMOVE option will remove the most recently run copy of AILANBIO.
  180.  
  181. ----------
  182.      VERBOSE
  183.  
  184. This switch is ON by default in the PE2AILAN.COM driver. It causes the 
  185. PE2AILAN.COM driver to display detailed information about the configuration 
  186. of the PE2AILAN.COM driver. See the messages section for a detailed 
  187. description of the VERBOSE output.
  188.  
  189. ---------
  190.      XEROX
  191.  
  192. This switch causes all transmitted packets to be in the XEROX format
  193. instead of the IEEE 802.3 standard.  When using this switch PE2AILAN.COM will
  194. receive both XEROX and IEEE 802.3 packets.
  195.  
  196. USING MULTIPLE ADAPTERS
  197. =======================
  198.  
  199. PE2AILAN.COM and AILANBIO.EXE communicate with each other using a DOS multiplex
  200. (MPX) number.  Each PE2AILAN.COM and AILANBIO.EXE pair supports one adapter.
  201. You will need to run an additional copy of PE2AILAN.COM and AILANBIO.EXE for
  202. each additional Xircom adapter installed in your computer.  Using command
  203. line switches, you must assign each PE2AILAN.COM and AILANBIO.EXE pair a 
  204. unique multiplex, adapter and IRQ number.  You must also specify the LPT port 
  205. to which each adapter is attached.  For example:
  206.  
  207.         PE2AILAN
  208.         AILANBIO
  209.         PE2AILAN/IRQ=5/MPX=D7/LPT=2
  210.         AILANBIO/ADAPTER=1/MPX=D7
  211.  
  212. The first invocation of PE2AILAN.COM and AILANBIO.EXE loads into the first
  213. adapter using the default MPX number (C7) interrupt request number (7) and
  214. adapter number (0).  This adapter is attached to LPT1.  The command line
  215. switches in the second invocation instruct the NETBIOS to load into the
  216. second adapter using interrupt request 5 and DOS MPX number D7.  This 
  217. adapter is attached to LPT2.
  218.  
  219.  
  220. PE2AILAN.COM MESSAGES
  221. =====================
  222.  
  223. The PE2AILAN.COM driver produces two types of messages: Informative and Error.
  224. All error messages are preceded by the text "ERROR:" and in those cases
  225. the PE2AILAN.COM driver is not installed.
  226.  
  227. --------
  228. MESSAGE:
  229.  
  230. Xircom Pocket Ethernet Adapter II AI-LANBIOS Driver Vn.nn
  231. (C) Copyright 1992 Xircom, Inc.
  232. Configuration: MPX = nn, LPT = nn, IRQ = nn
  233. Packet Type  : IEEE 802.3 Ethernet, 1500 bytes
  234. Parallel Port Mode will be determined automatically
  235.  
  236. This message appears each time the low-level driver is invoked.
  237.  
  238. --------
  239. MESSAGE:
  240.          ---- Pocket Ethernet II driver installed successfully ----
  241.  
  242. This message appears after the low-level driver is successfully installed.
  243.  
  244. --------
  245. MESSAGE:
  246.             ---- Pocket Ethernet II driver NOT installed ----
  247.  
  248. This message appears if the low-level driver is not installed.  The driver
  249. will not be installed if HELP information is displayed or an error
  250. occurred.
  251.  
  252. --------
  253. MESSAGE:
  254.  
  255. Command line                 /verbose
  256. IEEE 802.3 node address      0080C7d04489   Network packet size      1500
  257. MPX interface number         C7             Bytes of memory used     4000
  258. LPT interrupt request (IRQ)  7              LPT number               1
  259.  
  260. This message appears if the VERBOSE switch is specified.  The values
  261. displayed specify how the low-level driver is configured.  Some values may
  262. not agree with switch values specified on the command line.
  263.  
  264. --------
  265. MESSAGE:
  266.  
  267. Xircom Pocket Ethernet Adapter II AI-LANBIOS Driver Vn.nn
  268. (C) Copyright 1992 Xircom, Inc.
  269. Configuration: MPX = nn, LPT = nn, IRQ = nn
  270. Packet Type  : IEEE 802.3 Ethernet, 1500 bytes
  271. Parallel Port Mode will be determined automatically
  272.  
  273. Usage: PE2AILAN [?][Rem][Non][Xerox][Lpt=A][Irq=B][Mpx=C][Packet_Size=D]
  274. Where: ?  if present causes this message to be displayed
  275.      Rem  if present unloads the driver from memory
  276.      Non  if present forces the parallel port mode to Non-Bidirectional
  277.      Xerox if present sets the packet type to Xerox Ethernet
  278.      A    is the LPT port number             (1, 2, or 3               )
  279.      B    is the interrupt used by the parallel port (5 or 7           )
  280.      C    is the Multiplexed interrupt ID in hex  (C0 - FF, default C7 )
  281.      D    is the maximum packet size in decimal (574-1500, default 1500)
  282.   Note: If the Non, Lpt, or Irq options are not specified, the parallel
  283.         port mode, number, and interrupt will be set automatically. If the 
  284.         Xerox option is not specified, the packet type will be set to 
  285.         IEEE 802.3.
  286.  
  287.             ---- Pocket Ethernet II Driver NOT Installed ----
  288.  
  289. This message is displayed when the HELP or ? switch is used.  Each valid
  290. switch is listed with the acceptable range of values (if any) and the base
  291. (hex or decimal) that the numbers must be entered in.  The acceptable file
  292. size range for indirect files (@) is also listed.  The low-level driver is
  293. not installed when this switch is used.
  294.  
  295. -------
  296. MESSAGE:
  297.  
  298.                       ---- PE2AILAN removed ----
  299.  
  300. The PE2AILAN.COM driver has been removed from memory.
  301.  
  302. --------
  303. ERROR:    PE2AILAN not loaded
  304.  
  305. Meaning:  You have issued the PE2AILAN/REMOVE command and do not have PE2AILAN.COM
  306.           loaded into memory.
  307.  
  308. Remedy:   Only issue this command after the program is loaded.
  309.  
  310. -------
  311. ERROR:    Can't REMOVE -- PE2AILAN interrupts re-hooked
  312.  
  313. Meaning:  You have attempted to remove PE2AILAN.COM and the interrupts are in
  314.           use by another TSR, or PE2AILAN.COM was not the last TSR loaded.
  315.  
  316. Remedy:   Remove any TSRs loaded after PE2AILAN.COM.  For example, if you load
  317.           PE2AILAN.COM then AILANBIO.EXE, you must first remove AILANBIO.EXE,
  318.           then you can remove PE2AILAN.COM.
  319.  
  320. -------
  321. ERROR:    Installed PE2AILAN is different version
  322.  
  323. Meaning:  You have loaded a version of the PE2AILAN.COM program and attempted to
  324.           remove it from memory with the /REMOVE switch.  The version with
  325.           which you are attempting to remove PE2AILAN.COM is not the same
  326.           version that was loaded.
  327.  
  328. Remedy:   Remove PE2AILAN.COM with the same version of the program that was
  329.           loaded.
  330.  
  331. ------
  332. ERROR:   Cannot open indirect file - @file
  333.  
  334. Meaning: The file "file" cannot be opened as an indirect file.
  335.  
  336. Remedy:  The file must exist before it can be used as an indirect file.
  337.  
  338. ------
  339. ERROR:   Illegal character after switch name - ??????xnnnn
  340.  
  341. Meaning: The switch ?????? is followed by a character other than "=" or
  342.          ":" or the switch does not take a value.
  343.  
  344. Remedy:  Only use the characters "=" or ":" to specify switch values and
  345.          do not place characters after switches that do not take values.
  346.  
  347. ------
  348. ERROR:   Illegal digit in switch value - ??????=nnnn
  349.  
  350. Meaning: An illegal digit (character) occurred in the numeric
  351.          switch value.
  352.  
  353. Remedy:  You must restrict numeric decimal values to the numbers 0-9. 
  354.          You must restrict hexadecimal values to the numbers 0-9 and the
  355.          letters A-F.
  356.  
  357. ------
  358. ERROR:   Illegal switch - ??????=nnnn
  359.  
  360. Meaning: The switch ??????=nnnn is not a recognized switch.
  361.  
  362. Remedy:  You may only specify legal switches on the command line.
  363.  
  364. ------
  365. ERROR:   MPX number hh is already in use - Try another number
  366.  
  367. Meaning: The multiplex (MPX) interrupt number hh is being used by another
  368.          application or low-level driver.
  369.  
  370. Remedy:  Try another MPX number.
  371.  
  372. ------
  373. ERROR:   Pocket Ethernet Adapter II driver already loaded
  374.  
  375. Meaning: You have attempted to load a second copy of PE2AILAN.COM into the same
  376.          adapter.
  377.  
  378. Remedy:  Load only one copy of PE2AILAN.COM per adapter.  If you use multiple
  379.          adapters, make sure each copy of PE2AILAN.COM has a unique MPX, IRQ and
  380.          LPT value.
  381.  
  382. ------
  383. ERROR:   Pocket Ethernet Adapter II missing, not powered, or malfunctioned
  384.  
  385. Meaning: PE2AILAN.COM was unable to load into the Pocket Ethernet Adapter II.
  386.  
  387. Remedy:  Make sure the adapter is connected to your computer and that it is
  388.          powered up and correctly configured to match the PE2AILAN.COM software
  389.          settings.  If the error persists, contact Xircom Technical
  390.          Support. The adapter may need service.
  391.  
  392. ------
  393. ERROR:  Pocket Ethernet Adapter II address EEPROM unreadable.
  394.  
  395. Meaning: PE2AILAN.COM was unable to read the node address in the adapter EEPROM
  396.          chip.
  397.  
  398. Remedy:  Contact Xircom Technical Support.  The adapter may need service.
  399.  
  400. ------
  401. ERROR:  Pocket Ethernet Adapter II failed initialization.
  402.  
  403. Meaning: PE2AILAN.COM was unable to reset the adapter's NIC chip.
  404.  
  405. Remedy:  Contact Xircom Technical Support.  The adapter may need service.
  406.  
  407. ------
  408. ERROR:  Pocket Ethernet Adapter II failed memory test.
  409.  
  410. Meaning: PE2AILAN.COM was unable to read or write to the adapter's on-board RAM.
  411.  
  412. Remedy:  Contact Xircom Technical Support.  The adapter may need service.
  413.  
  414. ------
  415. ERROR:   Switch value not in range - ??????=nnnn
  416.          Valid range is ssss to eeee
  417.  
  418. Meaning: The value nnnn is not in proper range.  The value "ssss"
  419.          represents the lowest acceptable value and the value "eeee"
  420.          represents the highest acceptable value.
  421.  
  422. Remedy:  Limit your range of values to the acceptable range.
  423.  
  424.  
  425. TESTING PE2AILAN.COM RETURN CODES (ERROR LEVEL)
  426. ===============================================
  427.  
  428. You may test the PE2AILAN.COM return code or error level in a batch file by
  429. using the IF ERRORLEVEL command.  The following error levels are returned:
  430.  
  431.      0     No error has encountered.  PE2AILAN.COM driver installed
  432.      6     PE2AILAN not loaded
  433.      7     Can't remove, different version loaded
  434.      8     Cannot remove, interrupts re-hooked
  435.      9     ERROR: Can't REMOVE -- AI-LANBIOS (R) still installed
  436. ------------------
  437.  
  438.